Skip to content

Fixed swagger linting issues#10999

Merged
allenjzhang merged 2 commits intoAzure:masterfrom
akashkeshari:akash/ms.k8_swagger_fixes
Oct 12, 2020
Merged

Fixed swagger linting issues#10999
allenjzhang merged 2 commits intoAzure:masterfrom
akashkeshari:akash/ms.k8_swagger_fixes

Conversation

@akashkeshari
Copy link
Copy Markdown
Contributor

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service
  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

Please follow the link to find more details on PR review process.

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Sep 30, 2020

[Staging] Swagger Validation Report

BreakingChange: 9 Errors, 0 Warnings [Detail] [Expand]
Rule Message
1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L286:13
Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L286:13
1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L183:13
Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L183:13
1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L85:13
Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L85:13
1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L397:13
Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L397:13
1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L366:13
Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L366:13
1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L326:13
Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L326:13
1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L142:13
Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L142:13
1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: common-types/resource-management/v2/types.json#L273:5
Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L695:5
1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L227:13
Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L227:13
️✔️LintDiff [Detail]
 Validation passes for LintDiff. 
️✔️Avocado [Detail]
 Validation passes for Avocado. 
️✔️ModelValidation [Detail]
 Validation passes for ModelValidation. 
️✔️SemanticValidation [Detail]
 Validation passes for SemanticValidation. 
Posted by Swagger Pipeline | How to fix these errors?

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@openapi-sdkautomation
Copy link
Copy Markdown

openapi-sdkautomation Bot commented Sep 30, 2020

Azure CLI Extension Generation - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link
Copy Markdown

openapi-sdkautomation Bot commented Sep 30, 2020

azure-sdk-for-go - Release

️✔️ succeeded [Logs] [Expand Details]
  • ️✔️ Generate from f63047e with merge commit fb029cb. SDK Automation 13.0.17.20200918.2
  • ️✔️preview/hybridkubernetes/mgmt/2020-01-01-preview [View full logs]  [Release SDK Changes]
    Unable to get details about the head commit. This is probably because the head commit is in a fork that we don't have permission to read from. HttpError: Not Found {"name":"HttpError","status":404,"headers":{"access-control-allow-origin":"*","access-control-expose-headers":"ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset","connection":"close","content-encoding":"gzip","content-security-policy":"default-src 'none'","content-type":"application/json; charset=utf-8","date":"Mon, 12 Oct 2020 06:07:32 GMT","referrer-policy":"origin-when-cross-origin, strict-origin-when-cross-origin","server":"GitHub.com","status":"404 Not Found","strict-transport-security":"max-age=31536000; includeSubdomains; preload","transfer-encoding":"chunked","vary":"Accept-Encoding, Accept, X-Requested-With","x-content-type-options":"nosniff","x-frame-options":"deny","x-github-media-type":"github.v3; param=machine-man-preview; format=json","x-github-request-id":"0401:4E9C:1E39C1E:31D814E:5F83F2A4","x-xss-protection":"1; mode=block"},"request":{"method":"POST","url":"https://api.github.com/app/installations//access_tokens","headers":{"accept":"application/vnd.github.machine-man-preview+json","user-agent":"octokit.js/16.43.1 Node.js/13.14.0 (Linux 5.4; x64)","authorization":"bearer [REDACTED]","content-type":"application/json; charset=utf-8"},"body":"{}","request":{"validate":{"commit_sha":{"alias":"ref","deprecated":true,"type":"string"},"owner":{"required":true,"type":"string"},"ref":{"required":true,"type":"string"},"repo":{"required":true,"type":"string"},"sha":{"alias":"ref","deprecated":true,"type":"string"}}}},"documentation_url":"https://docs.github.com/rest"}

@openapi-sdkautomation
Copy link
Copy Markdown

openapi-sdkautomation Bot commented Sep 30, 2020

azure-sdk-for-js - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link
Copy Markdown

openapi-sdkautomation Bot commented Sep 30, 2020

azure-sdk-for-java - Release

️✔️ succeeded [Logs] [Expand Details]
  • ️✔️ Generate from f63047e with merge commit fb029cb. SDK Automation 13.0.17.20200918.2
  • ️✔️hybridkubernetes/resource-manager/v2020_01_01_preview [View full logs]  [Release SDK Changes]
    Unable to get details about the head commit. This is probably because the head commit is in a fork that we don't have permission to read from. HttpError: Not Found {"name":"HttpError","status":404,"headers":{"access-control-allow-origin":"*","access-control-expose-headers":"ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset","connection":"close","content-encoding":"gzip","content-security-policy":"default-src 'none'","content-type":"application/json; charset=utf-8","date":"Mon, 12 Oct 2020 06:06:53 GMT","referrer-policy":"origin-when-cross-origin, strict-origin-when-cross-origin","server":"GitHub.com","status":"404 Not Found","strict-transport-security":"max-age=31536000; includeSubdomains; preload","transfer-encoding":"chunked","vary":"Accept-Encoding, Accept, X-Requested-With","x-content-type-options":"nosniff","x-frame-options":"deny","x-github-media-type":"github.v3; param=machine-man-preview; format=json","x-github-request-id":"07C0:2F1E:59E41A8:696A98B:5F83F27C","x-xss-protection":"1; mode=block"},"request":{"method":"POST","url":"https://api.github.com/app/installations//access_tokens","headers":{"accept":"application/vnd.github.machine-man-preview+json","user-agent":"octokit.js/16.43.1 Node.js/13.14.0 (Linux 5.4; x64)","authorization":"bearer [REDACTED]","content-type":"application/json; charset=utf-8"},"body":"{}","request":{"validate":{"commit_sha":{"alias":"ref","deprecated":true,"type":"string"},"owner":{"required":true,"type":"string"},"ref":{"required":true,"type":"string"},"repo":{"required":true,"type":"string"},"sha":{"alias":"ref","deprecated":true,"type":"string"}}}},"documentation_url":"https://docs.github.com/rest"}

@openapi-sdkautomation
Copy link
Copy Markdown

openapi-sdkautomation Bot commented Sep 30, 2020

azure-sdk-for-net - Release

⚠️ warning [Logs] [Expand Details]
  • ⚠️ Generate from f63047e with merge commit fb029cb. SDK Automation 13.0.17.20200918.2
    [AutoRest] realpath(): Permission denied
    [AutoRest] realpath(): Permission denied
    [AutoRest] realpath(): Permission denied
    [AutoRest] realpath(): Permission denied
    [AutoRest] realpath(): Permission denied
    [AutoRest] realpath(): Permission denied
    Failed to find any changed packages. Please check the changed file list.
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/ConnectedClusterOperations.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/ConnectedClusterOperationsExtensions.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/ConnectedKubernetesClient.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/IConnectedClusterOperations.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/IConnectedKubernetesClient.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/IOperations.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/AuthenticationDetails.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/AuthenticationDetailsValue.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/AzureEntityResource.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/ConnectedCluster.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/ConnectedClusterAADProfile.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/ConnectedClusterIdentity.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/ConnectedClusterPatch.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/CredentialResult.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/CredentialResults.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/ErrorAdditionalInfo.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/ErrorResponse.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/ErrorResponseError.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/ErrorResponseException.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/Operation.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/OperationDisplay.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/Page.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/ProvisioningState.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/ProxyResource.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/Resource.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/ResourceIdentityType.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Models/TrackedResource.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/Operations.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/OperationsExtensions.cs
    /z/work/azure-sdk-for-net/sdk/Kubernetes/Management.Kubernetes/Generated/SdkInfo_ConnectedKubernetesClient.cs

@openapi-sdkautomation
Copy link
Copy Markdown

openapi-sdkautomation Bot commented Sep 30, 2020

azure-sdk-for-python - Release

- Breaking Change detected in SDK

⚠️ warning [Logs] [Expand Details]
  • ⚠️ Generate from f63047e with merge commit fb029cb. SDK Automation 13.0.17.20200918.2
  • ⚠️azure-mgmt-hybridkubernetes [View full logs]  [Release SDK Changes] Breaking Change Detected
    [build_conf] INFO:packaging_tools:Building template azure-mgmt-hybridkubernetes
    [build_conf] INFO:packaging_tools.conf:Skipping default conf since the file exists
    [build_conf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
    [build_conf] INFO:packaging_tools:Template done azure-mgmt-hybridkubernetes
    [build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
    [build_package]   warnings.warn(msg)
    [build_package] warning: no files found matching '*.py' under directory 'tests'
    [build_package] warning: no files found matching '*.yaml' under directory 'tests'
    [build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
    [build_package]   warnings.warn(msg)
    [build_package] warning: no files found matching '*.py' under directory 'tests'
    [build_package] warning: no files found matching '*.yaml' under directory 'tests'
    Unable to get details about the head commit. This is probably because the head commit is in a fork that we don't have permission to read from. HttpError: Not Found {"name":"HttpError","status":404,"headers":{"access-control-allow-origin":"*","access-control-expose-headers":"ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset","connection":"close","content-encoding":"gzip","content-security-policy":"default-src 'none'","content-type":"application/json; charset=utf-8","date":"Mon, 12 Oct 2020 06:05:13 GMT","referrer-policy":"origin-when-cross-origin, strict-origin-when-cross-origin","server":"GitHub.com","status":"404 Not Found","strict-transport-security":"max-age=31536000; includeSubdomains; preload","transfer-encoding":"chunked","vary":"Accept-Encoding, Accept, X-Requested-With","x-content-type-options":"nosniff","x-frame-options":"deny","x-github-media-type":"github.v3; param=machine-man-preview; format=json","x-github-request-id":"0702:3C2B:1C7AC72:2F5E69C:5F83F219","x-xss-protection":"1; mode=block"},"request":{"method":"POST","url":"https://api.github.com/app/installations//access_tokens","headers":{"accept":"application/vnd.github.machine-man-preview+json","user-agent":"octokit.js/16.43.1 Node.js/13.14.0 (Linux 5.4; x64)","authorization":"bearer [REDACTED]","content-type":"application/json; charset=utf-8"},"body":"{}","request":{"validate":{"commit_sha":{"alias":"ref","deprecated":true,"type":"string"},"owner":{"required":true,"type":"string"},"ref":{"required":true,"type":"string"},"repo":{"required":true,"type":"string"},"sha":{"alias":"ref","deprecated":true,"type":"string"}}}},"documentation_url":"https://docs.github.com/rest"}
    [breaking_change_setup] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
    [ChangeLog] Size of delta 17.356% size of original (original: 9616 chars, delta: 1669 chars)
    [ChangeLog] **Breaking changes**
    [ChangeLog] 
    [ChangeLog]   - Operation ConnectedClusterOperations.list_cluster_user_credentials has a new signature

@openapi-sdkautomation
Copy link
Copy Markdown

openapi-sdkautomation Bot commented Sep 30, 2020

azure-sdk-for-python-track2 - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link
Copy Markdown

openapi-sdkautomation Bot commented Sep 30, 2020

azure-resource-manager-schemas - Release

️✔️ succeeded [Logs] [Expand Details]
  • ️✔️ Generate from f63047e with merge commit fb029cb. Schema Automation 13.0.17.20200918.2
    [hybridkubernetes][after_scripts|node] configure: WARNING: secure clearing/zeroing of memory is not supported by the selected crypto backend
    [hybridkubernetes][after_scripts|node] configure: WARNING: secure clearing/zeroing of memory is not supported by the selected crypto backend
    [hybridkubernetes][after_scripts|node] configure: WARNING: secure clearing/zeroing of memory is not supported by the selected crypto backend
  • ️✔️hybridkubernetes [View full logs]  [Release Schema Changes]
      [after_scripts|node] PostProcessor finished successfully.
      [after_scripts|node]   5779 passing (1m)
      AzureResourceSchema has no registered package commands.
      Unable to get details about the head commit. This is probably because the head commit is in a fork that we don't have permission to read from. HttpError: Not Found {"name":"HttpError","status":404,"headers":{"access-control-allow-origin":"*","access-control-expose-headers":"ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset","connection":"close","content-encoding":"gzip","content-security-policy":"default-src 'none'","content-type":"application/json; charset=utf-8","date":"Mon, 12 Oct 2020 06:10:44 GMT","referrer-policy":"origin-when-cross-origin, strict-origin-when-cross-origin","server":"GitHub.com","status":"404 Not Found","strict-transport-security":"max-age=31536000; includeSubdomains; preload","transfer-encoding":"chunked","vary":"Accept-Encoding, Accept, X-Requested-With","x-content-type-options":"nosniff","x-frame-options":"deny","x-github-media-type":"github.v3; param=machine-man-preview; format=json","x-github-request-id":"0740:6A20:F4EEEF:21F8FFB:5F83F364","x-xss-protection":"1; mode=block"},"request":{"method":"POST","url":"https://api.github.com/app/installations//access_tokens","headers":{"accept":"application/vnd.github.machine-man-preview+json","user-agent":"octokit.js/16.43.1 Node.js/13.14.0 (Linux 5.4; x64)","authorization":"bearer [REDACTED]","content-type":"application/json; charset=utf-8"},"body":"{}","request":{"validate":{"commit_sha":{"alias":"ref","deprecated":true,"type":"string"},"owner":{"required":true,"type":"string"},"ref":{"required":true,"type":"string"},"repo":{"required":true,"type":"string"},"sha":{"alias":"ref","deprecated":true,"type":"string"}}}},"documentation_url":"https://docs.github.com/rest"}

    @openapi-sdkautomation
    Copy link
    Copy Markdown

    openapi-sdkautomation Bot commented Sep 30, 2020

    Trenton Generation - Release

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    Copy link
    Copy Markdown
    Member

    @majastrz majastrz left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    There is no breaking change in the API itself, so I'm signing off from the ARM side. However, there is a potential SDK breaking changes. @allenjzhang I'm leaving that for you to review and decide.

    Copy link
    Copy Markdown
    Contributor

    @allenjzhang allenjzhang left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Changing the operation id has an impact on SDK. Have you released any SDK already? If you have, I would like to request you to undo the change on the operation IDs.

    @allenjzhang allenjzhang added the Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review label Oct 2, 2020
    @azure-pipelines
    Copy link
    Copy Markdown

    Azure Pipelines successfully started running 1 pipeline(s).

    @akashkeshari
    Copy link
    Copy Markdown
    Contributor Author

    Changing the operation id has an impact on SDK. Have you released any SDK already? If you have, I would like to request you to undo the change on the operation IDs.

    I have reverted the operationId changes. Please review now.

    Copy link
    Copy Markdown
    Member

    @raunakpandya raunakpandya left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    :shipit:

    @allenjzhang allenjzhang added Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 and removed Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review labels Oct 12, 2020
    @allenjzhang allenjzhang merged commit fb029cb into Azure:master Oct 12, 2020
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Python potential-sdk-breaking-change

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants